[Search Bar/Query/Default Syntax] Parser support for "recognizedFields" options #7960
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tsullivan
force-pushed
the
eui/parse-query-update
branch
from
8fe6363
to
7d7f01a
Compare
1 task
tsullivan
force-pushed
the
eui/parse-query-update
branch
from
42b3539
to
c5a8707
Compare
cee-chen
reviewed
Aug 20, 2024
cee-chen
reviewed
Aug 20, 2024
cee-chen
approved these changes
Aug 20, 2024
There was a problem hiding this comment.
This looks great to me from an EUI point of view, thank you for the fantastic work Tim! I'll wait until end of week for @pugnascotia to chime in with any query/AST-specific feedback before merging.
💚 Build Succeeded
History
|
pugnascotia
reviewed
Aug 21, 2024
| fieldName "field name" | ||
| = identifier | ||
| = id:identifier &{ return !hasRecognizedFields || recognizedFields.includes(id); } { return id; } |
There was a problem hiding this comment.
What is the ampersand doing here?
There was a problem hiding this comment.
Unfortunately, PegJS documentation is no longer available directly, but it can be found here: http://web.archive.org/web/20240102234657/https://pegjs.org/documentation. Take a look under "Parsing Expression Types"
& expression
Try to match the expression. If the match succeeds, just return undefined and do not consume any input, otherwise consider the match failed.
In other words, the &{ return !hasRecognizedFields || recognizedFields.includes(id); } is a predicate check that determines whether the rule succeeds or fails. This check ensures that if hasRecognizedFields is truthy, then there is a restriction that the identifier must be included in the recognizedFields array to be treated as a field name. If the predicate passes, then the identifier is parsed as a field name. If the predicate does not pass, then the fieldName match is failed and the parser falls back to using the identifier rule.
By the way, I used Microsoft Copilot to explain this to me and help me with updating the parsing rules. If it wasn't for that, I am sure I would not have been able to figure it out.
There was a problem hiding this comment.
I checked the docs as they appear in source control, to double-check:
So this looks good.
Ikuni17
pushed a commit
to elastic/kibana
that referenced
this pull request
Aug 31, 2024
`v95.7.0` ⏩ `v95.9.0` > [!CAUTION] > This PR contains the final set of Emotion conversions for all EuiForm components. > If your plugin contains any custom CSS/styling to **EuiFormRow, EuiFormControlLayout, EuiCheckbox, EuiRadio, or EuiSwitch**,⚠️ make sure to QA your UI to ensure no visual regressions have occurred!⚠️ --- ## [`v95.9.0`](https://github.com/elastic/eui/releases/v95.9.0) - Updated `EuiSearchBar`'s optional `box.schema` prop with a new `recognizedFields` configuration. This allows specifying the phrases that will be parsed as field clauses ([#7960](elastic/eui#7960)) - Updated `EuiIcon` with a new `tokenSemanticText` glyph ([#7971](elastic/eui#7971)) - Added support for TypeScript 5 ([#7980](elastic/eui#7980)) **Bug fixes** - Fixed `EuiSelectableTemplateSitewide` styles when used within a dark-themed `EuiHeader` ([#7977](elastic/eui#7977)) ## [`v95.8.0`](https://github.com/elastic/eui/releases/v95.8.0) - Updated `EuiHeaderLinks`'s mobile menu to set a slight popover padding by default ([#7961](elastic/eui#7961)) - This can be overridden via `popoverProps.panelPaddingSize` if needed. - Updated `EuiHeaderLink` to default to a size of `s` (down from `m`) ([#7961](elastic/eui#7961)) **Accessibility** - Updated the `aria-label` attribute for the `EuiFieldSearch` clear button ([#7970](elastic/eui#7970)) **Bug fixes** - Fixed a visual bug with `<EuiDualRange showInput="inputWithPopover" />` form controls ([#7957](elastic/eui#7957)) **Deprecations** - Deprecated `EuiFormRow`'s `columnCompressedSwitch` display prop. Use `columnCompressed` instead, which will automatically account for child `EuiSwitch`es ([#7968](elastic/eui#7968)) - Deprecated `EuiFormRow`'s `rowCompressed` display prop. Use `row` instead for vertical forms, or `centerCompressed` for inline forms ([#7968](elastic/eui#7968)) - (Styling) Updated `EuiFormRow`'s `hasEmptySpaceLabel` prop to no longer attempt to automatically align its content to a vertical center. Use the `display="center"` prop for that instead ([#7968](elastic/eui#7968)) **CSS-in-JS conversions** - Converted `EuiFormControlLayout` to Emotion ([#7954](elastic/eui#7954)) - Removed `.euiFormControlLayout--*icons` classNames and `--eui-form-control-layout-icons-padding` CSS var. Use `--euiFormControlRightIconsCount` or `--euiFormControlLeftIconsCount` instead - Converted `EuiFormLayoutDelimited` to Emotion ([#7957](elastic/eui#7957)) - Fixed `cloneElementWithCss` throwing an error when used multiple times without a `key` prop ([#7957](elastic/eui#7957)) - Updated `cloneElementWithCss` utility to support a third argument that allows prepending vs. appending the cloned Emotion css className ([#7957](elastic/eui#7957)) - Removed `@euiFormControlLayoutClearIcon` Sass mixin ([#7959](elastic/eui#7959)) - Converted `EuiDescribedFormGroup` to Emotion ([#7964](elastic/eui#7964)) - Converted `EuiForm`, `EuiFormHelpText`, and `EuiFormErrorText` to Emotion ([#7966](elastic/eui#7966)) - Converted `EuiFormLabel` and `EuiFormLegend` to Emotion; Removed `@euiFormLabel` mixin ([#7967](elastic/eui#7967)) - Converted `EuiFormRow` to Emotion ([#7968](elastic/eui#7968)) - Converted `EuiCheckbox` to Emotion ([#7969](elastic/eui#7969)) - Converted `EuiRadio` to Emotion ([#7969](elastic/eui#7969)) - Converted `EuiSwitch` to Emotion ([#7969](elastic/eui#7969)) - Removed the following Sass variables: ([#7969](elastic/eui#7969)) - `$euiFormCustomControlDisabledIconColor` - `$euiFormCustomControlBorderColor` - `$euiRadioSize` - `$euiCheckBoxSize` - `$euiCheckboxBorderRadius` - `$euiSwitchHeight` (and compressed/mini variants) - `$euiSwitchWidth` (and compressed/mini variants) - `$euiSwitchThumbSize` (and compressed/mini variants) - `$euiSwitchIconHeight` - `$euiSwitchOffColor` - Removed the following Sass mixins: ([#7969](elastic/eui#7969)) - `euiIconBackground` - `euiCustomControl` - `euiCustomControlSelected` - `euiCustomControlDisabled` - `euiCustomControlFocused` --------- Co-authored-by: Marta Bondyra <[email protected]>
tsullivan
added a commit
to elastic/kibana
that referenced
this pull request
Sep 19, 2024
…cify recognized fields (#190464) This PR adds a new option to the `SchemaType` interface for parsing a query from a search in EuiSearchBar. This new field controls how EuiSearchBar text is parsed into a Query object. It enables better accuracy in how search terms are parsed when they include a `:` character. ## Release note Fixed an issue when using search bars with a term that includes a colon `:` character. ## Summary Closes #184496 Depends on elastic/eui#7960 **GLOBAL SEARCH: BEFORE**  **GLOBAL SEARCH: AFTER**  **SAVED OBJECTS MANAGEMENT: BEFORE**  **SAVED OBJECTS MANAGEMENT: AFTER**  **SAVED OBJECTS FINDER: BEFORE**  **SAVED OBJECTS FINDER: AFTER**  ## Checklist - [x] Ensure that filtering using `type:` and `tags:` still works
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Sep 19, 2024
…cify recognized fields (elastic#190464) This PR adds a new option to the `SchemaType` interface for parsing a query from a search in EuiSearchBar. This new field controls how EuiSearchBar text is parsed into a Query object. It enables better accuracy in how search terms are parsed when they include a `:` character. ## Release note Fixed an issue when using search bars with a term that includes a colon `:` character. ## Summary Closes elastic#184496 Depends on elastic/eui#7960 **GLOBAL SEARCH: BEFORE**  **GLOBAL SEARCH: AFTER**  **SAVED OBJECTS MANAGEMENT: BEFORE**  **SAVED OBJECTS MANAGEMENT: AFTER**  **SAVED OBJECTS FINDER: BEFORE**  **SAVED OBJECTS FINDER: AFTER**  ## Checklist - [x] Ensure that filtering using `type:` and `tags:` still works (cherry picked from commit 460ca2a)
kibanamachine
referenced
this pull request
in elastic/kibana
Sep 19, 2024
…to specify recognized fields (#190464) (#193448) # Backport This will backport the following commits from `main` to `8.x`: - [[Global Search, Saved Objects Management] Use new parse option to specify recognized fields (#190464)](#190464) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Tim Sullivan","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-19T16:02:45Z","message":"[Global Search, Saved Objects Management] Use new parse option to specify recognized fields (#190464)\n\nThis PR adds a new option to the `SchemaType` interface for parsing a\r\nquery from a search in EuiSearchBar. This new field controls how\r\nEuiSearchBar text is parsed into a Query object. It enables better\r\naccuracy in how search terms are parsed when they include a `:`\r\ncharacter.\r\n\r\n## Release note\r\nFixed an issue when using search bars with a term that includes a colon\r\n`:` character.\r\n\r\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/184496\r\nDepends on https://github.com/elastic/eui/pull/7960\r\n\r\n**GLOBAL SEARCH: BEFORE**\r\n\r\n\r\n\r\n**GLOBAL SEARCH: AFTER**\r\n\r\n\r\n\r\n**SAVED OBJECTS MANAGEMENT: BEFORE**\r\n\r\n\r\n\r\n**SAVED OBJECTS MANAGEMENT: AFTER**\r\n\r\n\r\n\r\n**SAVED OBJECTS FINDER: BEFORE**\r\n\r\n\r\n\r\n**SAVED OBJECTS FINDER: AFTER**\r\n\r\n\r\n\r\n## Checklist\r\n - [x] Ensure that filtering using `type:` and `tags:` still works","sha":"460ca2a83f0fd14b9d8c78c6b695e742c3f25930","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","Team:SharedUX","v8.16.0","backport:version"],"title":"[Global Search, Saved Objects Management] Use new parse option to specify recognized fields","number":190464,"url":"https://github.com/elastic/kibana/pull/190464","mergeCommit":{"message":"[Global Search, Saved Objects Management] Use new parse option to specify recognized fields (#190464)\n\nThis PR adds a new option to the `SchemaType` interface for parsing a\r\nquery from a search in EuiSearchBar. This new field controls how\r\nEuiSearchBar text is parsed into a Query object. It enables better\r\naccuracy in how search terms are parsed when they include a `:`\r\ncharacter.\r\n\r\n## Release note\r\nFixed an issue when using search bars with a term that includes a colon\r\n`:` character.\r\n\r\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/184496\r\nDepends on https://github.com/elastic/eui/pull/7960\r\n\r\n**GLOBAL SEARCH: BEFORE**\r\n\r\n\r\n\r\n**GLOBAL SEARCH: AFTER**\r\n\r\n\r\n\r\n**SAVED OBJECTS MANAGEMENT: BEFORE**\r\n\r\n\r\n\r\n**SAVED OBJECTS MANAGEMENT: AFTER**\r\n\r\n\r\n\r\n**SAVED OBJECTS FINDER: BEFORE**\r\n\r\n\r\n\r\n**SAVED OBJECTS FINDER: AFTER**\r\n\r\n\r\n\r\n## Checklist\r\n - [x] Ensure that filtering using `type:` and `tags:` still works","sha":"460ca2a83f0fd14b9d8c78c6b695e742c3f25930"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190464","number":190464,"mergeCommit":{"message":"[Global Search, Saved Objects Management] Use new parse option to specify recognized fields (#190464)\n\nThis PR adds a new option to the `SchemaType` interface for parsing a\r\nquery from a search in EuiSearchBar. This new field controls how\r\nEuiSearchBar text is parsed into a Query object. It enables better\r\naccuracy in how search terms are parsed when they include a `:`\r\ncharacter.\r\n\r\n## Release note\r\nFixed an issue when using search bars with a term that includes a colon\r\n`:` character.\r\n\r\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/184496\r\nDepends on https://github.com/elastic/eui/pull/7960\r\n\r\n**GLOBAL SEARCH: BEFORE**\r\n\r\n\r\n\r\n**GLOBAL SEARCH: AFTER**\r\n\r\n\r\n\r\n**SAVED OBJECTS MANAGEMENT: BEFORE**\r\n\r\n\r\n\r\n**SAVED OBJECTS MANAGEMENT: AFTER**\r\n\r\n\r\n\r\n**SAVED OBJECTS FINDER: BEFORE**\r\n\r\n\r\n\r\n**SAVED OBJECTS FINDER: AFTER**\r\n\r\n\r\n\r\n## Checklist\r\n - [x] Ensure that filtering using `type:` and `tags:` still works","sha":"460ca2a83f0fd14b9d8c78c6b695e742c3f25930"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Tim Sullivan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Needed for: elastic/kibana#184496
Context: EUI exports a class called Query which is responsible for parsing search terms into an AST. The parse() method of the class accepts a ParseOptions object, which is what has been changed in this PR. The Query class and ParseOptions objects come into play when consumers of EuiSearchBar wish to manage the query outside of the component, otherwise the EuiSearchBar component will control parsing the search terms into an AST internally.
What this does: This PR updates the "default syntax" parser, used to determine queries for the Search Bar component, to support a "recognizedFields" optional option.
Why: When used for searching structured content that is managed by Kibana (i.e., the Global Search Bar and Saved Objects Finders) the search bar should work more intuitively by using logic to infer what the user is trying to do. If the search bar is designed to support field clauses such as
type:typeAortag:tagB, it would be illogical to infer thatremote-cluster:my-remote-indexis a field clause.QA
General checklist